/*
 * Copyright 2020-2030 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/

package com.gitee.minimalismstyle.fresh.flowable.api.feign

import org.springframework.web.bind.annotation.*
import com.gitee.minimalismstyle.fresh.common.core.domain.R
import com.gitee.minimalismstyle.fresh.flowable.api.annotation.FlowableClient
import com.gitee.minimalismstyle.fresh.flowable.api.config.FlowableFeignConfig
import com.gitee.minimalismstyle.fresh.flowable.api.feign.model.CommentRequest
import com.gitee.minimalismstyle.fresh.flowable.api.feign.model.CommentResponse

/**
 * TaskComments
 * @author maoxiaodong
 */
@FlowableClient(configuration = [FlowableFeignConfig::class])
interface TaskCommentsApi {


    /**
     * List comments on a task
     */
    @GetMapping("/runtime/tasks/{taskId}/comments")
    fun listTaskComments(
        @PathVariable("taskId") taskId: String
    ): R<Any>

    /**
     * Create a new comment on a task
     */
    @PostMapping("/runtime/tasks/{taskId}/comments")
    fun createTaskComments(
        @PathVariable("taskId") taskId: String,
        @RequestBody(required = false) body: CommentRequest?
    ): R<CommentResponse>

    /**
     *  Get a comment on a task
     */
    @GetMapping("/runtime/tasks/{taskId}/comments/{commentId}")
    fun getTaskComment(
        @PathVariable("taskId") taskId: String,
        @PathVariable("commentId") commentId: String
    ): R<CommentResponse>

    /**
     * Delete a comment on a task
     */
    @DeleteMapping("/runtime/tasks/{taskId}/comments/{commentId}")
    fun deleteTaskComment(
        @PathVariable("taskId") taskId: String,
        @PathVariable("commentId") commentId: String
    ): R<Any>
}